ZerGo0_Bot Documentation

Appearance

Hype Trains ​

Hype Trains are an exciting way to celebrate and encourage community support during your livestreams. When multiple viewers tip or subscribe within a short time period, a special message will be sent in chat and the Hype Train overlay will be displayed on your stream.

What are Hype Trains? ​

Hype Trains are community-driven celebration events that activate when multiple viewers support you through tips or subscriptions within a configured time window. Similar to Twitch's hype train feature, they gamify collective support with:

  • Progressive Levels: Infinite level progression based on total dollar amount contributed
  • Community Recognition: Tracks the number of unique contributors
  • Real-time Progress: Shows current level, total amount contributed, and time remaining

How Hype Trains Work ​

Activation Requirements ​

  • Minimum Contributors: At least 3 different users must contribute (configurable)
  • Minimum Streak: At least 3 tips/subscriptions required (configurable)
  • Time Window: Contributions must occur within 5 minutes of each other (configurable)

Level Progression ​

Hype Trains feature infinite levels based on the total dollar amount contributed:

  • Level 1: Less than $5
  • Level 2: $5 - $14.99
  • Level 3: $15 - $29.99
  • Level 4: $30 - $49.99
  • Level 5: $50 - $74.99
  • Level 6-10: $75 - $199.99 (advances every $25)
  • Level 11-20: $200 - $499.99 (advances every $30)
  • Level 21-30: $500 - $999.99 (advances every $50)
  • Level 31-50: $1,000 - $2,999.99 (advances every $100)
  • Level 51+: $3,000+ (advances every $200)

Contribution Values ​

  • Tips: Count as their actual dollar amount
  • Subscriptions: Count as $1 each (regardless of tier)

Setting Up Hype Trains ​

1. Enable Hype Trains ​

Navigate to your Settings page and find the "Hype Trains" section:

  1. Toggle Enable Hype Trains to ON
  2. Configure your preferred settings:
    • Minimum Streak Count: Number of contributions needed to start
    • Minimum Contributors: Number of unique users required
    • Timeout Duration: Seconds before hype train expires

2. Customize Chat Messages ​

Hype Trains support fully customizable chat messages with dynamic variables. You can personalize all three types of announcements that appear in chat:

  • Start Message: Sent when the hype train begins
  • Level Up Message: Sent when the hype train reaches a new level
  • End Message: Sent when the hype train expires

Available variables for your messages:

  • {level} - The current hype train level
  • {contributors} - Number of unique contributors
  • {amount} - Total contribution amount (formatted as currency)

To customize these messages:

  1. Go to your Hype Trains settings
  2. Find the "Chat Messages" section
  3. Edit each message type using the available variables:
    • Hype Train Start Message
    • Level Up Message
    • Hype Train End Message
  4. Save your changes

3. Add the Hype Train Overlay ​

Add the hype train overlay to your streaming software:

  1. Copy your overlay URL from the Overlays tab > Hype Train section:
  2. In OBS or your streaming software:
    • Add a new Browser Source
    • Paste the overlay URL
    • Set dimensions if needed